Other Classes

Options for calculating results from the Mapbox Directions service.

You do not create instances of this class directly. Instead, create instances of MatchOptions or RouteOptions.

A DirectionsResult represents a result returned from either the Mapbox Directions service.

You do not create instances of this class directly. Instead, you receive Route or Match objects when you request directions using the Directions.calculate(_:completionHandler:) or Directions.calculateRoutes(matching:completionHandler:) method.

An instruction about an upcoming RouteStep’s maneuver, optimized for speech synthesis.

The instruction is provided in two formats: plain text and text marked up according to the Speech Synthesis Markup Language (SSML). Use a speech synthesizer such as AVSpeechSynthesizer or Amazon Polly to read aloud the instruction.

The distanceAlongStep property is measured from the beginning of the step associated with this object. By contrast, the text and ssmlText properties refer to the details in the following step. It is also possible for the instruction to refer to two following steps simultaneously when needed for safe navigation.

The contents of a banner that should be displayed as added visual guidance for a route. The banner instructions are children of the steps during which they should be displayed, but they refer to the maneuver in the following step.

A visual instruction banner contains all the information necessary for creating a visual cue about a given RouteStep.